vbslib

(for Internet Explorer)

Sub DefaultFunction( Argument1 as variant )

何もしないコールバック関数の本体。

第1引数（無視します）

イベントが発生したらコールバックされる関数の集合。
イベント関数を呼び出すオブジェクトのプロパティに、本クラスのオブジェクトを設定します。

イベントが発生したときにコールバックされる関数を登録します。

コールバックされる関数を登録解除します。

→ T_Item_vbslib フォルダ

イベントが発生したときに、登録されているコールバック関数を呼び出します。

Sub EventResponders::Add( Func as EventFunction, Responder as variant, Priority as integer )

イベントが発生したときにコールバックされる関数を登録します。

コールバックされる関数

イベントに応答するオブジェクト

caller_object.OnEventX.Add GetRef( "ResponderClass_OnEventX" ), Me, 1000

1000 が標準。
EventResponders のオブジェクトに登録した複数のコールバックのうち、
Priority が小さいものから先にコールバックされます。

Sub EventFunctionSample( Responder as variant, Caller as variant, Args as variant )

イベント関数。イベントが発生したらコールバックされる関数の型。

イベントに応答するオブジェクト

イベントが発生したオブジェクト

イベントのパラメーター（イベントの内容による）

caller_object.OnEventX.Remove Me

Sub EventResponders::Remove( Responder as variant )

コールバックされる関数を登録解除します。

イベントに応答するオブジェクト

Sub EventResponders::Calls( Caller as variant, Args as variant )

イベントが発生したときに使い、登録されているコールバック関数を全て呼び出します。

イベントが発生したオブジェクト

イベントのパラメーター（イベントの内容による）

Me.OnEventX.Calls Me, Empty

Class_Initialize でエラーが発生してもエラーが発生しない問題に対応します。

Function CreateGuid() as string

GUID を生成します。

2D7E3038-E395-460A-86CC-C8AB3C3D5D54

グローバル変数 g_TestModeFlags に、F_NotRandom を設定すると、
テスト・プログラム用に 00000000-0000-0000-0000-000000000000 から順番に
+1 された値が返ります。
g_TypeLib = 0 にすると、再び 1 から順番に値を返します。

Function KeyClass::IsSame( Key as object ) as boolean

Function KeyClass::SetKey( Key as object ) as object

キーとなるオブジェクトを登録します。一度しか登録できません。返り値は、Key です。

以前登録したキーと同じかどうかを判定します。

Dim g_AppKey

Dim AppKey : Set AppKey = new KeyClass ' for Ident only
Set g_AppKey = new KeyClass : g_AppKey.SetKey( AppKey )

If not g_AppKey.IsSame( AppKey ) Then Err.Raise 1,,"Invalied AppKey"

以前登録した特定のオブジェクトかどうかを判定します。
KeyClass から特定のオブジェクトを取得することはできないので、グローバルスコープに、
KeyClass オブジェクトを置いても、特定のオブジェクトへの参照を複製することから守ります。

ファイル、またはフォルダが同一かどうかを比較します。

ファイルまたはフォルダを削除します。

src から dst にファイルまたはフォルダをコピーします。

フォルダを作成します。

カレントフォルダを移動します。

src から dst にファイルまたはフォルダを移動します。

フォルダまたはファイルが存在するかどうかを返します。

テキストファイルの中で、指定したキーワードを含む行を返します。

指定のテキストを内容とした、テキストファイルを作成します。

ワイルドカードを展開します。サブ・フォルダーも検索します。

他にもあります。左のツリーから選択してください。

ファイル名を変更します。

相対パスを返します。

書き込み可能なフォルダの設定オブジェクトを生成します。

書き込み可能なフォルダを設定します。

書き込み可能でない場所にライトしたときの動きを設定します。

スクリプトが想定していない場所にライトしたときの警告

テキストファイルの内容を表示します。

コマンドプロンプト準拠関数

vbslib オリジナル関数

圧縮(zip)ファイルを解凍します。

FileSystemObject を参照するグローバル変数です。

ファイルを操作する主な関数を下に一覧します。
すべての関数は、左のツリーを展開してください。

テキストファイルを開きます。（リード用）

テキストファイルを開きます。（ライト用）

テキストファイルの内容を変更します。

フル・パスを返します。

テンポラリ・フォルダの中のパスを返します。

サブフォルダのオブジェクトを高速に辞書に列挙します。

指定した名前のファイルをライトするときにブレークさせます。

負荷が高いときに発生する書き込み拒否エラーに対処します。

一部がバイナリになっているテキストファイルを作成します。

CSV 形式の１行を解析して、配列に格納します。

XML ファイル、または XML 形式の文字列を読み込みます。

Sub cd( Path as string )

カレント・フォルダーを変更します。

存在しないフォルダを指定すると、E_WIN32_FILE_NOT_FOUND エラーになります。
ファイルのパスを指定すると、E_WIN32_DIRECTORY エラーになります。

cd "FolderA"
t = ReadFile( "File.txt" )

→ T_cd_do.vbs # cd

カレント・フォルダーの中にある FolderA フォルダーに、カレント・フォルダー
を変更します。 File.txt は、FolderA フォルダーにあるファイルになります。

現在のカレント・フォルダーを、プロセス起動時のカレント・フォルダーに
変更します。

main 関数、または main2 関数を呼ばれたときのカレント・フォルダーは、プロセス起動時
のカレント・フォルダーではなく、メイン.vbs ファイルがあるフォルダーになります。
メイン.vbs ファイルがあるフォルダーからの相対パスを指定するときは、cd 関数を呼び
出す必要はありません。 (この仕様は、vbslib4 から)

新しいカレント・フォルダーのパス

Sub funcA()
Dim ds_:Set ds_= new CurDirStack

cd "sub"
End Sub '// 元のフォルダに戻る

オブジェクトが破棄されるタイミングで、カレント・フォルダーを元に戻すオブジェクトです。
下記の場合、関数 funcA から返ると、CurDirStack オブジェクトのデストラクタで、関数に
入ったときのカレント・フォルダーに戻ります。

→ T_cd_do.vbs # CurDirStack

Sub pushd( dir as string )

カレントフォルダを移動します。ただし、popd で戻れるようにします。

→ T_cd_do.vbs # pushd

pushd "FolderA"
popd '// 元のフォルダに戻る

カレントフォルダを pushd する前に戻します。

→ T_cd_do.vbs # popd

pushd "FolderA"
popd '// 元のフォルダに戻る

Sub cd_UpperCaseDrive()

カレント・フォルダーのドライブの文字を大文字に変更します。

cd "c:\Folder"
cd_UpperCaseDrive
Assert g_sh.CurrentDirectory = "C:\Folder"

→ vbslib.vbs [cd_UpperCaseDrive]

→ T_cd_do.vbs # [T_cd_UpperCaseDrive]

SrcPath のファイルまたはフォルダを、DstFolderPath フォルダーの中にコピーします。

Sub copy( SrcPath as string, DstFolderPath as string )

copy 関数は、ファイルやフォルダの有無によって動きが変わらないようにするため、コマンド
プロンプトの copy や FileSystemObject の CopyFile 関数と、若干動きが異なります。
しかし、エクスプローラーなどの一般的なファイラーの動きと同じです。

DstFolderPath 引数

a.txt を dst_folder にコピーします
（dst_folderがフォルダのとき）

a.txt フォルダーを作成して、その中に a.txt を
コピーします

フォルダ aa を作成して、aa フォルダの中に
aa フォルダをコピーします

フォルダ aa を dst_folder の中にコピーします

ワイルドカード

ファイルとフォルダを dst_folder にコピーします

フォルダ bb を作成して、その中へファイルと
フォルダをコピーします。

フォルダ bb を作成して、bb フォルダの中に
aa フォルダをコピーします

コピー元のファイルパス、またはフォルダーパス

コピー先のフォルダーパス（ファイルパスは不可）

copy "src", "dst"
copy "src\*", "dst"

src フォルダーの内容を dst フォルダーの中にコピーします

SrcPath に指定したファイルが見つからない

DstFolderPath がロックされているか、ファイルが存在する

src フォルダーを dst フォルダーの中にコピーします

→ T_Copy.vbs # [T_Copy]

vbslib3 の copy の DstFolderPath に指定したパスがフォルダーではないときは、ファイル名を
変える動きでしたが、vbslib4 の copy では、必ず DstFolderPath の新規フォルダーを作成して、
その中へコピーします。これは、エクスプローラーなどの一般的なファイラーの動きと同じです。
コピーと同時にファイル名を変える時は、copy_ren を使ってください。

g_Vers("CopyTargetIsFileOrFolder") = 1

vbslib ver3 との違い

コピー先にファイルがあっても、上書き確認をユーザーに行わずに、上書きします。
ユーザーには、上書きするフォルダーやファイルのバックアップをとるようにガイドしてください。

フォルダーをコピーするとき、SrcPath のフォルダーと DstFolderPath のフォルダーを全く同じ
ファイル構成にしたいときは、DstFolderPath のフォルダーを削除してからコピーしてください。
そうしなければ、DstFolderPath の中にあるファイルと同じ場所にあるファイルが SrcPath の
中にに無くても、そのファイルは無くならないためです。これは、エクスプローラーなどの一般的
なファイラーの動きと同じです。

コピー元のフォルダー

コピーする前のコピー先

コピーした後のコピー先

vbslib ver3 の copy やコマンドプロンプトの copy と動きが異なる場合があります。（下記）

vbslib3 で作成したスクリプトをそのまま動かすと、DstFolderPath にファイルパスを指定した
copy は、指定したファイル名と同じ名前のフォルダの中にコピーするようになります。しかし、
そのまま、実行を続けても、開こうとするファイルがフォルダーであるため開けない、というエラー
でブレークするため、大きな問題にはならないでしょう。また、ファイルには一般に拡張子が
付いているので、vbslib3 で作成した copy を vbslib4 で動かすと、拡張子が付いたフォルダー
が作られます。拡張子が付いたフォルダーがあれば、copy の移植を検討してください。

vbslib3 の仕様に戻したいときは、下記のように設定してから copy を呼び出してください。

仕様を変更した理由は、copy する前の DstFolderPath がフォルダーであるかないかによって、
コピー先が変わらないようにするためです。（あるかないかを判定する If 文が不要になります）

Sub copy_ren( SrcPath as string, DstPath as string )

ファイルまたはフォルダーの名前を変えてコピーします。 (copy and rename)

コピー元のファイル、または、フォルダーのパス

コピー先のファイル、または、フォルダーのパス

SrcPath がファイルなら、DstPath に指定したパスもファイルにしてください。
SrcPath がフォルダーなら、DstPath に指定したパスもフォルダーにしてください。

フォルダーをコピーするとき、SrcPath のフォルダーと DstPath のフォルダーを
全く同じファイル構成にしたいときは、DstPath のフォルダーを削除してからコピー
してください。

copy_ren "src", "dst"

src フォルダーの内容を dst フォルダーの中にコピーします。
または、src ファイルの内容を、dst ファイルの中にコピーします。

copy_ren "src", "dst"
copy "src\*", "dst"

上記の２行は、同じ処理です。
src フォルダーの内容を dst フォルダーの中にコピーします。

→ T_Copy.vbs # [T_Copy]

Sub copy_ex( SrcPath as string, DstPath as string, Option_ as integer )

Option_ に指定したように、特殊なコピーをします。

コピー元のパス。ワイルドカードが使えます

コピー先のフォルダーのパス

特殊なコピーの内容

SrcPath に指定したワイルドカード以外の部分をカットしたファイル名になるようにコピーします。
サブフォルダにあるファイルもコピーします。

Dim c : Set c = g_VBS_Lib
copy_ex "src\*_set1.*", "dst", c.CutTag

src フォルダーにある _set1. を名前に含むファイルを、dst フォルダーにコピーします。
ただし、ファイル名の一部にある _set1 はカットされます。

複数のファイルが入ったフォルダが複数あって、それらを上書きコピーして合成したフォルダから、
元の１つのフォルダを取り出すようなコピーができます。

コピー先に同じ名前のファイルがあるファイルだけ、コピーします。

Set c = g_VBS_Lib
copy_ex "src\*", "dst", c.ExistOnly

file1.txt と file3.txt だけコピーします。

Set c = g_VBS_Lib
copy_ex "src\*", "dst", c.MakeShortcutFiles

dst フォルダ（新規作成）

コピー先にコピー元のそれぞれのファイルへのショートカットを作成します。

コピー先に同じ名前のファイルや空フォルダーがないファイルだけ、コピーします。

Set c = g_VBS_Lib
copy_ex "src\*", "dst", c.NotExistOnly

file2.txt と file4.txt と EmptyFolder だけコピーします。